home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1995 October / EnigmA AMIGA RUN 01 (1995)(G.R. Edizioni)(IT)[!][issue 1995-10][Aminet 7].iso / Aminet / comm / cnet / call_logger33.lha / call_log1 / Call_Logger_READ_ME! < prev   
Text File  |  1995-06-11  |  19KB  |  394 lines
  1. ===========================================================================
  2.         Call Logger, v3.3 READ_ME File By Dotoran of Frontiers BBS!
  3. ===========================================================================
  4.  
  5.     This is a "Last 10 Callers" type of program, but gives the Sysop a lot
  6. more flexibility in the customization of the finished output file. The out-
  7. put file is suitable for use as a GFile on your system, or for inclusion
  8. into your "sys.welcome" file.
  9.  
  10.     For those upgrading from v2.0, please search out the term CONVERT for
  11. information on installing the new version.
  12.  
  13.     If converting from v3.2, simply replace the Call_Logger file you're
  14. currently using with the newer one that came in this archive.
  15.  
  16. What you should have:
  17. ~~~~~~~~~~~~~~~~~~~~~
  18.     The following files should have been included with this archive. If any
  19. of the files is missing, DO NOT TRUST THIS ARCHIVE!
  20.  
  21.     Call_Log1                   - Directory.
  22.         Call_Logger             - Arexx Command File.
  23.         Call_Logger_READ_ME!    - This Text File.
  24.         Call_Logger_HISTORY!    - Lists Changes to Call_Logger.
  25.         !FRONTIERS!             - How to contact the author, Dotoran.
  26.  
  27. What will Call_Logger do:
  28. ~~~~~~~~~~~~~~~~~~~~~~~~~
  29.     Call_Logger will create a text file listing past callers to your system,
  30. along with stats on what they did while online. Each line in the Call_Log
  31. follows the format given below:
  32.  
  33. 0  1  *Dotoran          96 [prudgtfm]  10:00a 10:25a  3  Ami  50   12   2
  34. |  |  |   |              |     |         |      |     |   |    |    |   |
  35. A  B  C   D              E     F         G      H     I   J    K    L   M
  36.  
  37. A: Port connection was made to.
  38. B: The ID number of the user who logged on.
  39. C: The NEW USER flag. If present, this is user's first call to your system.
  40. D: Handle of the user who logged on.
  41. E: Baud rate user connected with(divided by 100).
  42. F: Activity Flags:
  43.     P:ost, R:esponse, U:pload, D:ownload, G:ame, T:ext, F:eedback, M:ail
  44.     "Nothing!" will be printed if NONE of the above flags occurred.
  45. G: Sign-On time of the user.
  46. H: Log-Off time of the user.
  47. I: User's access group number.
  48. J: User's computer type(first three characters only).
  49. K: Total number of calls this user has made to your system.
  50. L: Total number of uploaded files this user has made to your system.
  51. M: Total number of posts AND responses this user has written.
  52.  
  53. How to install the Logger:
  54. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  55.     To install Call_Logger, v3.3, follow these steps:
  56.  
  57. 1: Copy the "Call_Log1" directory and it's files into the directory you
  58.    house your pfiles in, normally "PFILES:"
  59.  
  60. 2: In the "bbstext" file, on line 99 of the 3.05c version, locate
  61.    the following text: "@ Logoff complete\n1".
  62.  
  63. 3: Add the following to the END of that line, so that the finished line
  64.    looks like this:
  65.  
  66.    @ Logoff complete\n1{#0pfiles:Call_Log1/Call_Logger}
  67.                        ^
  68.                     Control-Q
  69.  
  70. 4: Add the following line somewhere in your "sys.welcome" file:
  71.  
  72.            {*0gfiles:Call_Log}
  73.            ^
  74.         Control-Q
  75.  
  76. 5: If you want a wait to immediately follow the Call_Log, add this line
  77.    right after the above line in your "sys.welcome" file:
  78.  
  79.            \cfPress \c6ENTER \cfnow...\i1
  80.            `--------^---.----^--------'
  81.                         |
  82.                 CONTROL-Y characters
  83.  
  84.     That is all you HAVE to do to get the Logger functioning on your system,
  85. but you may want to customize the Logger to suit your needs better.
  86.  
  87. How to customize the Logger:
  88. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  89.     To customize the Logger for a more personal touch, you may edit the 17
  90. variables located near the beginning of the "Call_Logger" file. To do this,
  91. load the "Call_Logger" file into your favorite text editor. Starting on line
  92. 9 are the seventeen Sysop definable variables that will be described fully
  93. below:
  94.  
  95. V1:     {Ignore Ports}      - Default is [LOG ALL PORTS]
  96. ~~~
  97.     This variable allows you to specify any ports you wish NOT to be logged.
  98.     To add ports to the variable, enclose them in double quote marks and
  99.     make sure to separate them with at least ONE space.
  100.  
  101.     EXAMPLES:   "0"     -   Do NOT log calls made from port # 0.
  102.                 "0 2"   -   Do NOT log calls made from ports 0 or 2.
  103.                 "X"     -   Log calls from ALL PORTS.
  104. ____________________________________________________________________________
  105.  
  106. V2:     {Ignore ID's}       - Default is [LOG ALL ID NUMBERS]
  107. ~~~
  108.     This variable allows you to specify any ID numbers you do NOT want
  109.     logged. To add ID numbers, follow the same rules as for "V1".
  110.  
  111.     EXAMPLES:   "1"     -   Do NOT log calls made by ID number 1.
  112.                 "1 2"   -   Do NOT log calls from ID numbers 1 or 2.
  113.                 "0"     -   Do NOT log calls made by "guests".
  114.                 "X"     -   Log calls from ALL ID NUMBERS.
  115.  
  116.     NOTE:   Guests are NEW users that do not supply a PASSWORD.
  117. ____________________________________________________________________________
  118.  
  119. V3:     {Ignore Accesses}   - Default is [LOG ALL ACCESS LEVELS]
  120. ~~~
  121.     This variable allows you to specify any Access Levels you do NOT want
  122.     logged. To add Access Levels, follow the "V1" rules.
  123.  
  124.     EXAMPLES:   "0"     -   Do NOT log calls made by Access Level 0 users.
  125.                 "30 31" -   Do NOT log level 30 or level 31 users.
  126.                 "X"     -   Log calls from ALL ACCESS LEVELS.
  127. ____________________________________________________________________________
  128.  
  129. V4:     {Max To Ever Log}   - Default is [LOG 10 CALLS: LAST 10 CALLERS]
  130. ~~~
  131.     This variable allows you to control the size of the Call_Log file. You
  132.     can set this variable to ANY value, but I suggest keeping it between
  133.     1 and 13. This number tells the Logger the total number of calls that
  134.     can ever be in the Call_Log at one time.
  135. ____________________________________________________________________________
  136.  
  137. V5:     {Save Call-Backs}   - Defaults to [DO NOT SAVE CALL BACKS]
  138. ~~~
  139.     This variable allows (or disallows) the Logger to log Call-Backs. A
  140.     call-back is when the same user calls your system twice in a row. This
  141.     variable can have two(2) values:
  142.  
  143.         V5 = 0  - ( Call Backs should NOT be logged; default)
  144.         V5 = 1  - ( Call Backs should ALWAYS be logged)
  145. ____________________________________________________________________________
  146.  
  147. V6:     {Log Sysops}        - Defaults to [LOG EVERY FIFTH SYSOP CALL]
  148. ~~~
  149.     This variable allows you to specify how often the Logger will log calls
  150.     made by the SysOp(only ID Number 1). The Logger keeps track of each time
  151.     the SysOp passes through the Logger and logs their call when the total
  152.     equals this value.
  153. ____________________________________________________________________________
  154.  
  155. V7:     {Activity BackDrop} - Defaults to [ 2  - ( [--------] ) ]
  156. ~~~
  157.     This variable defines what the Non-Use Activity Flags will look like.
  158.     The variable can have a value between one(1) and seven(7).
  159.  
  160.         V7 = 1 ( gives: [........] )       V7 = 2 ( gives: [--------] )
  161.         V7 = 3 ( gives: [prudgtfn] )       V7 = 4 ( gives: [********] )
  162.         V7 = 5 ( gives: [xxxxxxxx] )       V7 = 6 ( gives: [========] )
  163.         V7 = 7 ( Non-Use Activity Flags will use character in V8 )
  164.  
  165.      NOTE: If using the new Quick Call_Log output, it is suggested that you
  166.            use a value of 1 or 2 for V7 for the best readability.
  167.  
  168.     NOTE2: If no activity was performed by the logged caller, the flag data
  169.            will be replaced with [Nothing!].
  170. ____________________________________________________________________________
  171.  
  172. V8:     {V7 Filler}         - Defaults to [THE   #   CHARACTER]
  173. ~~~
  174.     This variable is used in conjunction with the V7 variable. In fact, the
  175.     V8 variable is ONLY used when the V7 variable holds a 7.    V7 = 7
  176.     The character within the V8 variable is used as the Non-Use character
  177.     in the Activity Flags when V7 = 7.
  178.  
  179.     EXAMPLES:   V7 = 7   &   V8 = "#"  ( gives: [########] )
  180.                 V7 = 7   &   V8 = "^"  ( gives: [^^^^^^^^] )
  181. ____________________________________________________________________________
  182.  
  183. V9:     {Abortable Log}     - Defaults to [ALLOW LOG TO BE ABORTED]
  184. ~~~
  185.     This variable allows you to create a Call_Log that can be aborted by the
  186.     user when the /, SPACE, or CTRL-C key combinations are pressed, or to
  187.     create a Call_Log that can NOT be aborted with these sequences.
  188.  
  189.         V9 = 0  - ( Log can NOT be aborted by the user)
  190.         V9 = 1  - ( Log CAN be aborted by the user)
  191. ____________________________________________________________________________
  192.  
  193. V10:    {Output Type}       - Defaults to [QUICK CALL_LOG OUTPUT]
  194. ~~~~
  195.     This is a NEW variable to Call_Logger v3.0. You can now choose between
  196.     two different looking Call_Logs.
  197.  
  198.         V10 = 0  - ( The elaborate BLUE Call_Log from v2.0)
  199.         V10 = 1  - ( The NEW Quick Grey Call_Log from v3.0)
  200. ____________________________________________________________________________
  201.  
  202. V11:    {Log Ordering}      - Defaults to [NEWEST CALLS FIRST IN LOG]
  203. ~~~~
  204.     This is a NEW variable to Call_Logger v3.0. You can now choose which
  205.     order you wish the call data to come in.
  206.  
  207.         V11 = 0  - ( The NEWEST calls come first in the Log)
  208.         V12 = 1  - ( The OLDEST calls come first in the Log)
  209. ____________________________________________________________________________
  210.  
  211. V12:    {Quick Colors}      - Defaults to [ db   (Lt.Purple/Lt.Yellow)]
  212. ~~~~
  213.     This is a NEW variable to Call_Logger v3.0. This variable is only used
  214.     with the NEW Quick Log( V10 = 1 ). The contents of this variable tell
  215.     the Logger which colors to make the call entries in the Quick Log. The
  216.     colors will cycle through. The default value will create a Quick Log
  217.     using Light Purple and Light Yellow for the Log entries. The contents
  218.     of this variable are the MCI color codes needed, MINUS the \c
  219.  
  220.     EXAMPLES:   V12 = '9fc'     - ( Creates a RED / WHITE / BLUE Quick Log)
  221.                 V12 = '6e'      - ( Creates a CYAN / LIGHT CYAN Quick Log)
  222. ____________________________________________________________________________
  223.  
  224. V13:    {Notate Ignores}    - Defaults to [DO NOT NOTATE IGNORED CALLS]
  225. ~~~~
  226.     This is a NEW variable to Call_Logger v3.0. This variable allows you to
  227.     notate that a call was made, but will not list personal data if the call
  228.     that passed through the Logger would normally have been ignored, as set
  229.     by the values in the V1, V2, V3, V5, and V6 variables.
  230.  
  231.         V13 = 0  - ( Do NOT notate ignored calls)
  232.         V13 = 1  - ( NOTATE any calls that would normally be ignored)
  233. ____________________________________________________________________________
  234.  
  235. V14:    {Border Color}      - Defaults to [Use BRIGHT BLUE for Border]
  236. ~~~~
  237.     This variable is NEW to Call_Logger v3.3! I discovered that the Dark
  238.     Grey color of the Border used in the Quick Log format showed as BLACK
  239.     on 8-color terminal screens, so I needed to change the color, but then
  240.     I thought the SysOps might like the ability to change it themselves.
  241.  
  242.         V14 = "1"  - ( Use \cc (dark red) for border color )
  243.         V14 = "f"  - ( Use \cf (bright white for border color )
  244. ____________________________________________________________________________
  245.  
  246. V15:    {Clear Screen}      - Defaults to [CLEAR SCREEN BEFORE DISPLAYING]
  247. ~~~~
  248.     This variable is NEW to Call_Logger v3.3! This variable allows you to
  249.     specify if you wish the screen to be CLEARED before the Call_Log is
  250.     displayed on the screen. By NOT clearing the screen, you get kind of a
  251.     neat "scrolling" effect to the log that some SysOps might enjoy.
  252.  
  253.         V15 = 1    - ( Clear the screen before displaying log )
  254.         V15 = 0    - ( Do NOT clear the screen before displaying log )
  255. ____________________________________________________________________________
  256.  
  257. D1:     {Call_Log Path}     - Defaults to [  GFILES:  ]
  258. ~~~
  259.     This variable tells the Logger where to store the outputted Call_Log
  260.     file. Normally, this would be the Gfiles: directory, but in the event
  261.     you wish to store it elsewhere, you will need to change this variable.
  262.     The contents of this variable must ALWAYS end with either a colon( : ),
  263.     or a slash( / ).
  264.  
  265.     NOTE: If you CHANGE this variable, you will also have to edit the line
  266.           you added to the "sys.welcome" file to reflect this change.
  267.  
  268.     NOTE2: This is the reason the directory is called "Call_Log2", just in
  269.            case you wish to store it in the PFILES: path.
  270. ____________________________________________________________________________
  271.  
  272. D2:     {Logger Path}       - Defaults to [  PFILES:CALL_LOG1/  ]
  273. ~~~
  274.     This variable tells the Logger where to store the support files it uses
  275.     to create the Call_Log. The support files "Call_Log_Computers3" and
  276.     "Call_Log_Config" will be created by Call_Logger the first time it is
  277.     used. Normally, this path will be to the "Call_Log1" directory in your
  278.     pfiles: area, where the "Call_Logger", "_READ_ME!", and "_HISTORY!"
  279.     files are located. The contents of this variable must ALWAYS end with
  280.     either a colon( : ), or a slash( / ).
  281.  
  282.     NOTE: If you CHANGE this variable, you will also have to edit line 99
  283.           of the "bbstext" file to reflect this change.
  284. ____________________________________________________________________________
  285.  
  286. Editing Variables PostLogged:
  287. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  288.     The Logger has been tested thoroughly as far as changing the variables
  289. on the fly. Although changing certain variables may have an obverse affect
  290. on how the Log looks, eventually the Log will clean itself up:
  291.  
  292.    EXAMPLE1: Your running the Elaborate BLUE Log and decide you want to
  293.              change to the NEW Quick Grey Log. Simply changing the V10
  294.              variable is all that is needed. Both Logs line up, but you
  295.              will notice that some of the older entries in the Log are of
  296.              the Elaborate type. After a couple of calls, these OLD Log
  297.              entries will be replaced by newer Quick Log entries.
  298.  
  299.    EXAMPLE2: Your using dashes for the Log Activity and decide to go with
  300.              the lowercase letters. Simply change the V7 variable. Older
  301.              entries will still have the dashes, while newer entries will
  302.              use the lowercase letters. Just as above, as soon as a couple
  303.              more calls are logged, the older dashed entries will vanish.
  304.  
  305.    EXAMPLE3: You decide to reverse the ordering of the Log from Oldest 1st
  306.              to Newest 1st. You simply change the V11 variable. You will
  307.              notice that the SignOn/SignOff times don't seem to match up.
  308.              Again, soon they will, once a couple more calls are logged.
  309. ____________________________________________________________________________
  310.  
  311. Using the Logger:
  312. ~~~~~~~~~~~~~~~~~
  313.     To use the log, simply log onto your bbs. If you've added the "Call_Log"
  314. file somewhere in your logon(like in "sys.welcome"), then you will be shown
  315. the log. Once you've logged on, log yourself off. The Logger will log your
  316. call, unless you've specified variables that will not capture your call.
  317.  
  318.     You will know for sure that the Logger logs your call if it prints the
  319. message: "Logging your call..." directly below the "@ Logoff complete"
  320. message. If the "Logging your call..." message does NOT print on your screen
  321. AND no error messages print as well, then you have one or more variables
  322. set to IGNORE your call.
  323.  
  324.     This file does all it's work at LOGOFF, which is nice, because the user
  325. is not having to wait while the file writes data to the disk. All disk ops
  326. are performed once AFTER a user signs off.
  327.  
  328.     The first time you use the logger, a "Call_Log_Computers3" file will be
  329. created in your D2 variable path. The Call_Logger program will actually look
  330. at how you have your Computer Types set up(in BBSMENU), and will create the
  331. file to contain the EXACT computers you have set up for your unique board.
  332.  
  333.     To RESTART the Log, simply delete the file "Call_Log" from your D1
  334. variable path. The log will start anew.
  335.  
  336.     To reconfigure for new Computer types, delete "Call_Log_Computers3" from
  337. your D2 variable path. The updated file will be created the first time the
  338. Call_Logger is used again.
  339.  
  340.     You should NEVER delete the file called "Call_Log_Config". Doing so will
  341. result in unknown results occurring in the log. If you happen to mistakenly
  342. delete this file, then you should also delete "Call_Log_Computers" and the
  343. "Call_Log" file and start a fresh log.
  344.  
  345.     The text file "Call_Log" is a suitable file for use as a GFile as well,
  346. so feel free to add it into your GFile section.
  347.  
  348. How to convert from v2.0:
  349. ~~~~~~~~~~~~~~~~~~~~~~~~~
  350.     Converting to v3.3 from v2.0 couldn't be simpler:
  351.  
  352. 1: Replace the older "Call_Logger" with the newer one in this archive.
  353.  
  354. 2: Delete the "Call_Log_Computers", "Call_Log_Config", and "Call_Log"
  355.    files from their appropriate directories. v3.3 is SO new these old
  356.    files are incompatible.
  357.  
  358. 3: Set the SysOp definable variables within the "Call_Logger" file to
  359.    fit your current needs. There are a couple NEW variables with v3.0,
  360.    so look above for more info on how their used.
  361.  
  362.     That's all there is to it. No changes were made to the "sys.welcome"
  363. and "bbstext" lines from v2.0, so no editing of those is needed. Run the
  364. logger the same way you always have, and ENJOY!
  365.  
  366. That's It Folks!
  367. ~~~~~~~~~~~~~~~~
  368.     Well, I rewrote this _READ_ME! in hopes of making it a bit easier to
  369. understand the gobs of info I am trying to shove down your throats. PLEASE,
  370. READ THIS ENTIRE DOCUMENT TO FULLY UNDERSTAND WHAT'S GOING ON!!!
  371.  
  372.     That'll do it for this version. If you see I've made a mistake, or you
  373. think the Logger needs something else, feel free to contact me on Future
  374. World, or if you're a REALLY nice person, give my BBS a call for all the
  375. latest creations I've come up with.
  376.  
  377.     I run all my mods on my bbs, both those that have been released, and
  378. those that are still in BETA stages, so if you want a looksie into the
  379. future of Dotoran Files, give a call!!!
  380.  
  381.                               Dotoran's
  382.               ___  ___  ___        ____  ____  ___  ___  ___
  383.              /_   /__/ /  / /\  /   /     /   /_   /__/ /__
  384.             /    / /  /__/ /  \/   /   __/_  /__  / /  ___/
  385.  
  386.                         Bulletin Board System
  387.  
  388.                     ( 7 1 6 ) / 8 2 3 - 9 8 9 2 !
  389.  
  390.                     Now from 300 thru 28,800 baud!
  391. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  392.       Once again, the runner finds the finish line ahead of others!
  393. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  394.